home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / ra_111.zip / AVTCONV.ARJ / AVTCONV.DOC next >
Text File  |  1991-10-25  |  6KB  |  144 lines
  1.     ┌──────────────────────────────────────────────────────────────┐
  2.     │      RemoteAccess Avatar Conversion Utility version 1.01     │
  3.     │           copyright (c) S/e/m/a/j Communications.            │
  4.     └──────────────────────────────────────────────────────────────┘
  5.  
  6. The RemoteAccess Avatar Conversion utility, or AVTCONV, will convert
  7. your existing ansi (.ANS) screens into Avatar (.AVT) screens suitable
  8. for use with RemoteAccess 1.10.
  9.  
  10. Conversion of screens into Avatar is always possible, but not always
  11. easy. If ANVCONV says that a screen cannot be converted, then you should
  12. load the screen into TheDraw, or similar ANSI drawing package, and
  13. resave it with no line length limit.
  14.  
  15. Screens containing RemoteAccess control codes may need special care.
  16.  
  17.  
  18.                            What AVTCONV does
  19.                            ─────────────────
  20.  
  21. For the technically minded, AVTCONV directly translates the following
  22. ANSI control codes:
  23.  
  24.         ESC [ ... H             direct cursor movement
  25.         ESC [ ... f             direct cursor movement
  26.  
  27.         ESC [ 2 J               clear screen
  28.         ESC [ K                 erase line
  29.         ESC [ ... m             set graphics rendition.
  30.  
  31. AVTCONV handles the following control codes in a special way:
  32.  
  33.         ESC [ ... A             relative cursor movement
  34.         ESC [ ... B             relative cursor movement
  35.         ESC [ ... C             relative cursor movement
  36.         ESC [ ... D             relative cursor movement
  37.  
  38.         ESC [ s                 save cursor position
  39.         ESC [ u                 restore cursor position
  40.  
  41. Since the AVATAR control codes do not allow easy multiple cursor movements
  42. in any direction, and for speed, AVTCONV replaces relative cursor movements
  43. with a direct cursor movement. If AVTCONV is not sure of it's
  44. position, or, there are less than two cursor movements in a row, it is
  45. more efficient to use repeated relative cursor movements, so that's what
  46. it does.
  47.  
  48. If AVTCONV knows where it is on the screen, it strips the save cursor
  49. position command, and replaces the restore cursor position command with
  50. a goto cursor position command. If it encounters these commands and it
  51. doesn't know where you are on the screen, it reports that the file cannot
  52. be converted.
  53.  
  54. Additionally, AVTCONV automatically scans for repeated characters and
  55. reduces them to an Avatar "repeat character" sequence if this would be
  56. more efficient (byte-wise). Lastly, if enabled, AVTCONV can compress
  57. the file even further using advanced pattern recognition features.
  58.  
  59. Unfortuately, at the moment, hardly any comms packages support pattern
  60. expansion which contains avatar codes, so, this compression is not selected
  61. by default. Besides which, the scanning mechanism is slow!
  62.  
  63.  
  64.                           How to use AVTCONV
  65.                           ──────────────────
  66.  
  67. With this release of AVTCONV, a number of switches have been provided to allow
  68. greater flexibility, and speed.
  69.  
  70. Options should be specified on the command line.  They can be preceeded by
  71. either a "/" or a "-".  Most of the options are "toggles". You should
  72. append either a "+" or "-" to turn on or off the option respectively. If
  73. you don't specify either, then the option is turned on.
  74.  
  75. eg.    AVTCONV /o- /c /a+ /x95
  76.  
  77.     Would turn off cursor optimisation, AVT/0+ compression on,
  78.     animation delays on and sets the screen width to 95.
  79.     
  80. The default for each of the
  81.  
  82.  
  83.     /o        Cursor optimisation.
  84.     (active)    When on, AVTCONV will scan through your file removing
  85.             redundant save/restore cursor position commands, to
  86.             further decrease the size of the AVT file.
  87.             
  88.     /c        AVT/0+ compression.
  89.     (off)        Although RemoteAccess supports AVT/0+ compression,
  90.             many communications programs do not. Even FrontDoor
  91.             v2.00 has problems with this compression, so its
  92.             probably not a good idea to use this until more
  93.             programs support AVT/0+.  Basically, this option
  94.             enables a pattern recognition search, further
  95.                         decreasing the size of your AVT file. Unfortunately,
  96.             this is very slow, but I hope to speed it up in
  97.             a future version.    
  98.  
  99.     /r        RLE compression.
  100.     (on)        This is simple data compression supported by all
  101.             Avatar compatible communications packages. There
  102.             should be no reason to turn it off, but you can
  103.             if you like...!
  104.             
  105.     /a        Animation delays.
  106.     (off)        Normally, AVTCONV ignores the delays put into
  107.             animation by programs such as TheDraw, but when
  108.             this option is specified, these delays are
  109.             included.
  110.             
  111.     /x        Screen width.
  112.     (80)        Follow this command by width of your screen. There
  113.             should be no reason to alter it from 80, but
  114.             just in case..
  115.             
  116.     /y        Screen height.
  117.     (25)        This option should be followed by the height of your
  118.             screen. See screen width for more information.
  119.  
  120. To run AVTCONV, simply type..
  121.             
  122.    AvtConv [options] [path] [ext]
  123.  
  124. where,
  125.  
  126.   path is the path to the files you want to convert (eg \RA\TXT\*.ANS),
  127.   the default is *.ANS
  128.  
  129.   ext is the extension to put on the new files, the default is AVT.
  130.  
  131. Examples of use:
  132.  
  133.    AVTCONV
  134.    will convert *.ANS in the current directory to .AVT files.
  135.  
  136.    AVTCONV /c- C:\RA\TXTFILES\*.ANS AKK
  137.    will convert *.ANS in the ra textfiles directory to .AKK files without
  138.    cursor optimisation.
  139.  
  140.    AVTCONV \*.ANS /r-
  141.    will convert *.ANS in the root directory to .AVT files, with RLE
  142.    compression off.
  143.  
  144.